Installing HCL™ Accelerate with Docker Compose
Install HCL™ Accelerate into the Docker Compose container orchestrator.
Before you begin
- Docker installed on the host system. Note: If you use Docker for Windows, make sure Docker is using Linux-type containers. HCL™ Accelerate does not support Windows-type containers.
- Internet connection. During installation, files and container images are retrieved from remote
locations. If you are unable to access the internet during installation, you can download the files
beforehand and perform an offline installation.
HCL™ Accelerate supports the following browsers: Chrome, Firefox, and Edge.Note: Steps to retrieve the container images from public repository to your private repository:
Use
pull
command to pull the container images from public repository.$ docker pull public repo
Use
tag
command to tag the public and private repository.$ docker tag public repo private repo
Use
push
command to push container images to private repository.$ docker push private repo
All the container images are retrieved from public to private repository.
If you are performing an offline installation of HCL™ Accelerate, GraphQL Playground will not load for use.
In addition to the requirements for all installation scenarios, the following items are required for Docker Compose systems:
- Docker Compose version 17.09.0-ce, build afdb6d4 and later
- CPU with 4+ cores.
- 8GB RAM
- 8GB storage
- If you are using offline installation, you will need both 4GB free in your
/tmp
or\temp
directory and 8 GB of disk space for MongoDB. - If you are installing the product on Red Hat Enterprise Linux®, you need RHEL 7 or later.
root
user. If you do not want to use
sudo
with the docker
command, create a Linux group called
docker
. Ensure that the user who installs the product is a member of that group.
See the Docker documentation for more information about managing Docker as the non-root
user.Get a key. The key enables you to complete installation. Visit the HCL™ Accelerate web portal to obtain your key. After completing the form, you will receive a confirmation email with an access key. Store the key in a readily-available location; you use it during installation.
About this task
The installation instructions describe installing the product on all supported operating systems. The downloaded executable file steps you through the installation process and sets your installation parameters.
Procedure
-
Download the installation file for your environment.
Note: For macOS and Linux installations, set the appropriate permissions before running the file:
sudo chmod +x
. - Run the downloaded executable file.
-
Complete installation by responding to the prompts described in the following
steps:
When the script starts, you are prompted to accept the license. You can explicitly accept the license without viewing it by appending the following parameter to the command:
./<Accelerate-installation-file> --license=accept
The images are loaded on the local host. -
Complete installation by changing to the directory where you installed the product, and start
Docker Compose. For example:
~/projects/accelerate/ docker-compose up -d
The HCL™ Accelerate images are pulled from Docker Hub and configured for Docker Compose.
What to do next
Access the
HCL™ Accelerate Web UI. The URL is https://hostname:port, where hostname
and port
are the values that you set during installation. The initial user name is
admin and the default password is admin.
- Access_Key
- The product access key obtained earlier.
- NGINX_HOST
- The domain of the URL the users will use to access HCL™ Accelerate. The value is usually the hostname of the virtual machine where Docker Compose is running.
openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certifcate.pem
Place your self-generated key and certificate in the [Accelerate-install-folder/product_version_number/conf/ssl folder.
After you purchase the product, you receive a permanent access key, and a license key.